/*!
 * # 参数列表实体类:
 *  Details - 详细信息
 * 
 * # 描述:
 *  查询和显示某一条日志消息的详细说明信息。
 *  
 *  Copyright (c), 上海沃恩信息科技有限公司.
 *  All rights reserved.
 *  Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

using Pittypat;

namespace Waln.Log.Mop.Args
{
	/// <summary>
	/// 功能 详细信息 的参数列表。
	/// </summary>
	[global::Pittypat.Function(Transaction = false)]
	public sealed class Details : global::Pittypat.FunctionArgs
	{
		#region 构造函数

		/// <summary>
		/// 初始化 Details 类的一个新实例。
		/// </summary>
		public Details()
		{
			// 管理员用户 Id
			this.AdministratorId = null;
			// 消息 Id
			this.Id = null;
			// 消息正文
			this.Body = null;
		}

		#endregion

		#region 属性

		/// <summary>
		/// 获取或者设置管理员用户 Id。
		/// </summary>
		/// <remarks>
		/// 当前作为管理员的用户的 Id，由系统自动设置该参数。
		/// </remarks>
		[global::Pittypat.Parameter(0, Role = global::Pittypat.ParameterRole.UserId)]
		public @uuid? AdministratorId { get; set; }

		/// <summary>
		/// 获取或者设置消息 Id。
		/// </summary>
		/// <remarks>
		/// 日志消息的 Id。
		/// </remarks>
		[global::Pittypat.Parameter(1)]
		public @int64? Id { get; set; }

		/// <summary>
		/// 获取或者设置消息正文。
		/// </summary>
		/// <remarks>
		/// 对数据库操作的详细说明信息。
		/// </remarks>
		[global::Pittypat.Parameter(2, Direction = global::Pittypat.ParameterDirection.Out, MaxLength = 20000)]
		public @string? Body { get; set; }

		/// <summary>
		/// 获取或者设置指定名称的参数值。
		/// </summary>
		/// <param name="name">参数名称，不区分大小写。</param>
		/// <returns>目标名称的参数值。如果参数不存在，则返回 null。</returns>
		/// <exception cref="global::System.ArgumentException">设置参数值时发现参数不存在。</exception>
		public override object this[string name]
		{
			get
			{
				if (string.IsNullOrEmpty(name))
				{
					return null;
				}

				switch (name.ToLower())
				{
					case "administratorid":
						return this.AdministratorId;
					case "id":
						return this.Id;
					case "body":
						return this.Body;
					default:
						return null;
				}
			}
			set
			{
				if (string.IsNullOrEmpty(name))
				{
					throw new global::System.ArgumentException("没有提供有效的参数名称。", "name");
				}

				switch (name.ToLower())
				{
					case "administratorid":
						this.AdministratorId = (@uuid?)value;
						break;
					case "id":
						this.Id = (@int64?)value;
						break;
					case "body":
						this.Body = (@string?)value;
						break;
					default:
						throw new global::System.ArgumentException(name + " 不是 " + this.GetType().Name + " 的有效参数名称。", "name");
				}
			}
		}

		#endregion

		#region 方法

		/// <summary>
		/// 将当前对象作为 JSON 字符串写入指定的文本流。
		/// </summary>
		/// <param name="writer">目标文本流。</param>
		/// <exception cref="global::System.ArgumentNullException">writer 是 null。</exception>
		public override void Write(global::System.IO.TextWriter writer)
		{
			if (writer == null)
			{
				throw new global::System.ArgumentNullException("writer");
			}

			writer.Write('{');

			// 管理员用户 Id
			writer.Write("\"administratorId\":");
			this.AdministratorId.Write(writer);
			writer.Write(',');

			// 消息 Id
			writer.Write("\"id\":");
			this.Id.Write(writer);
			writer.Write(',');

			// 消息正文
			writer.Write("\"body\":");
			this.Body.Write(writer);

			writer.Write('}');
		}

		#endregion
	}
}
